Skip to content

docs: fix incorrect -f flag in logs examples, should be --follow#1023

Open
latenighthackathon wants to merge 2 commits intoNVIDIA:mainfrom
latenighthackathon:docs/fix-logs-follow-flag
Open

docs: fix incorrect -f flag in logs examples, should be --follow#1023
latenighthackathon wants to merge 2 commits intoNVIDIA:mainfrom
latenighthackathon:docs/fix-logs-follow-flag

Conversation

@latenighthackathon
Copy link
Copy Markdown
Contributor

@latenighthackathon latenighthackathon commented Mar 27, 2026 •
edited by coderabbitai bot
Loading

Summary

Fix incorrect -f shorthand in docs/monitoring/monitor-sandbox-activity.md. The CLI only accepts --follow — the -f flag is silently ignored, causing users to miss real-time log output.

Related Issue

Fixes #1021

Changes

  • Line 57: nemoclaw <name> logs -f → nemoclaw <name> logs --follow
  • Line 90: nemoclaw <name> logs -f → nemoclaw <name> logs --follow

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only. Prose changes without code sample modifications.
  • Doc only. Includes code sample changes.

Testing

  • npx prek run --all-files passes (or equivalently make check).
  • npm test passes.
  • make docs builds without warnings. (for doc-only changes)

Checklist

General

Doc Changes

  • Follows the style guide.
  • New pages include SPDX license header and frontmatter, if creating a new page.
  • Cross-references and links verified.

Summary by CodeRabbit

  • Documentation
    • Standardized log-following examples to use the long-form --follow flag across monitoring and troubleshooting instructions for consistent real-time log streaming.
    • Fixed minor formatting that split a status/list command across lines, restoring readability without changing the commands.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 2026 •
edited
Loading

Warning

Rate limit exceeded

@latenighthackathon has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 7 minutes and 19 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 7 minutes and 19 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6407a1d1-0d06-4a27-96bd-3bb2984e4197

📥 Commits

Reviewing files that changed from the base of the PR and between 48f30e2 and bb794e0.

📒 Files selected for processing (1)
  • docs/monitoring/monitor-sandbox-activity.md
📝 Walkthrough

Walkthrough

Updated documentation examples in monitor-sandbox-activity.md to replace the unsupported short -f log flag with the correct long --follow option in two places so examples match the CLI behavior.

Changes

Cohort / File(s) Summary
Documentation Fix
docs/monitoring/monitor-sandbox-activity.md		 Replaced -f with --follow in two code examples (real-time log streaming and troubleshooting step). Minor line-wrapping adjusted in the "Check Sandbox Health" section without changing commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I hopped through docs to find the flaw,
A -f that broke the logging law.
Swapped in --follow, steady and bright,
Now logs stream on through day and night. 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the primary change: fixing incorrect -f flag documentation to use --follow in the logs examples.
Linked Issues check ✅ Passed The pull request fully addresses issue #1021 by replacing -f with --follow at both documented locations (lines 57 and 90) in monitor-sandbox-activity.md, matching the CLI implementation.
Out of Scope Changes check ✅ Passed The pull request contains only the necessary documentation fixes to resolve the linked issue; the minor line-wrapping in the health check section is a style guide compliance change mentioned in the PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Mar 27, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/monitoring/monitor-sandbox-activity.md (1)

44-44: Consider splitting into one sentence per line.

Line 44 contains two sentences. Per the style guide, one sentence per line makes diffs more readable.

📝 Suggested formatting 
-Run `nemoclaw <name> status` on the host to check sandbox state. Use `openshell sandbox list` for the underlying sandbox details.
+Run `nemoclaw <name> status` on the host to check sandbox state.
+Use `openshell sandbox list` for the underlying sandbox details.

As per coding guidelines: "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/monitoring/monitor-sandbox-activity.md` at line 44, Split the two
sentences on line 44 into separate lines so each sentence is one line: change
"Run `nemoclaw <name> status` on the host to check sandbox state. Use `openshell
sandbox list` for the underlying sandbox details." into two lines — one
containing "Run `nemoclaw <name> status` on the host to check sandbox state."
and the next containing "Use `openshell sandbox list` for the underlying sandbox
details." — ensuring the exact sentence strings remain unchanged.
🤖 Prompt for all review comments with AI agents 
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/monitoring/monitor-sandbox-activity.md`:
- Line 44: Split the two sentences on line 44 into separate lines so each
sentence is one line: change "Run `nemoclaw <name> status` on the host to check
sandbox state. Use `openshell sandbox list` for the underlying sandbox details."
into two lines — one containing "Run `nemoclaw <name> status` on the host to
check sandbox state." and the next containing "Use `openshell sandbox list` for
the underlying sandbox details." — ensuring the exact sentence strings remain
unchanged.
ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 835c297e-03bc-45a6-a3ca-3197619f5eab

📥 Commits

Reviewing files that changed from the base of the PR and between 5c269c1 and cccebbd.

📒 Files selected for processing (1)
  • docs/monitoring/monitor-sandbox-activity.md

@latenighthackathon latenighthackathon force-pushed the docs/fix-logs-follow-flag branch from cccebbd to 959e6d2 Compare March 27, 2026 05:53
@latenighthackathon
docs: fix incorrect -f flag in logs examples, should be --follow
2ff34fb 
The CLI only accepts --follow (bin/nemoclaw.js line 805), not -f.
The commands reference (docs/reference/commands.md) correctly
documents --follow but monitor-sandbox-activity.md used -f.
@latenighthackathon
style(docs): split multi-sentence line per style guide
bb794e0 
Address CodeRabbit nitpick: split two sentences on line 44 into
separate lines for more readable diffs per the project style guide.
@latenighthackathon latenighthackathon force-pushed the docs/fix-logs-follow-flag branch from b7dfd3a to bb794e0 Compare March 29, 2026 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[NemoClaw][Doc] monitor-sandbox-activity.md uses -f flag but CLI only accepts --follow

1 participant

@latenighthackathon